.TH igcreator 1
.SH NAME
igcreator \- generate static XHTML galleries from images
.\" ===== SYNOPSIS ===
.SH SYNOPSIS
.B igcreator
.RI [ options...
] 
.I images...
.PP
.B igcreator
.RB [ \-d
.IR path ] 
.RI [ options...
]
.PP
.B igcreator \-h
.\" ===== DESCRIPTION ===
.SH DESCRIPTION
With
.B igcreator
you can create static XHTML galleries from images. The program creates the necessary HTML pages, thumbnails and pictures. With different options you can specify sizes for thumbnails and pictures.
.B igcreator
will handle the resizing. 
.PP
The HTML files are created using templates. These are basically XHTML files with
few keys in them.
.B igcreator
comes with default templates, which are quite simple, but you can easily change the appearance using the css file. For more complex look you can use your own templates.
.\" ===== OPTIONS ====
.SH OPTIONS
.TP
.B \-\-version
Display version and exit
.TP
.B \-h, \-\-help
Display a help text and exit
.TP
.I images...
List of images from which to create the gallery from. If
.B \-\-imagedir
option is specified these will be ignored.
.TP
.BI "\-d " path ", \-\-imagedir=" path
A directory where to find the pictures. If this is specified
.B igcreator
will only look images from that directory. Images given as arguments will be ignored.
.TP
.BI "\-o " path ", \-\-outputdir=" path
A directory where to create the gallery. All HTML files and picture files will be created to this directory. Thumbnails will be created to thumbs/ subdirectory. If this option is not specified
.B igcreator
will create the gallery to the running directory.
.TP
.BI "\-s " sizeopt ", \-\-size=" sizeopt
Specify a size for pictures. With
.I sizeopt
you can specify how the images will be resized. The aspect ratio will always be kept. If you do not specify this option pictures will not be resized. Possible values for 
.I sizeopt
are
.RS
.TP
width=<pixels>
Specify max width for the picture. If picture width is smaller than <pixels> this will be ignored.
.TP
height=<pixels>
Specify max height for the picture. If picture height is smaller than <pixels> this will be ignored
.TP
long=<pixels>
Specify max length for the longer side of picture.
.TP
short=<pixels>
Specify max length for the shorter side of picture.
.TP
help
Prints a short help text about
.I sizeopts
and exits.
.RE
.TP
.BI "\-t " sizeopt ", \-\-thumbsize=" sizeopt
Same as
.B \-\-size
but for thumbnails. If this option is not specified
.I sizeopt
value width=150 will be used.
.TP
.BI "\-f " filter ", \-\-filter=" filter
Specify a filter used in image resizing. Possible values for
.I filter
are:
.RS
.TP
nearest
Fastest but poor quality.
.TP
bilinear
Fast and ok quality.
.TP
bicubic
Slightly better than bilinear but slower.
.TP
antialias
Best quality but also the slowest.
.TP
help
Prints a short help about filters and exits.
.RE
.TP
.BI "\-p " file ", \-\-pictemplate=" file
Specify a template file for picture HTML pages. If you do not use this option
.B igcreator
will use the default picture template.
.TP
.BI "\-T " file ", \-\-thumbtemplate=" file
Specify a template file for thumbnail HTML page. If you do not use this option
.B igcreator
will use the default thumbnail template.
.TP
.BI "\-H " string ", \-\-heading=" string
Specify a heading for the gallery. If the option is not specified heading will be "Gallery".
.\" ===== PICTURE TEMPLATE =====
.SH PICTURE TEMPLATE
The picture template keys are:
.TP
.B $PICTITLE
Picture name.
.TP
.B $NAVIGATION
The navigation buttons. In XHTML code the buttons are basically list items
with links, so they need to be inside <ul>...</ul> tags.
.TP
.B $PICTURE
<img src="... /> tag for the picture.
.\" ===== THUMBNAIL TEMPLATE =====
.SH THUMBNAIL TEMPLATE
The thumbnail template keys are:
.TP
.B $TITLE
The title for the gallery. This can be specified using the
.B \-\-heading
option.
.TP
.B $THUMBS
The thumbnails. They are basically images inside a <div class="thumb">...</div> tags.
.\" ===== AUTHOR =====
.SH AUTHOR
Ville Leskinen <vleskinen at gmail.com>
.\" ===== SEE ALSO =====
.SH SEE ALSO
.TP
.B igCretor web page
<http://users.tkk.fi/~vleskine/igcreator/index_en.html>
